<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Encryption: CaesarCrypt Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Encryption
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_caesar_crypt.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_caesar_crypt-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">CaesarCrypt Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Implements the Caesar-Crypt algorithm.  
 <a href="class_caesar_crypt.html#details">More...</a></p>

<p><code>#include &lt;CaesarCrypt.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CaesarCrypt:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_caesar_crypt.png" usemap="#CaesarCrypt_map" alt=""/>
  <map id="CaesarCrypt_map" name="CaesarCrypt_map">
<area href="class_crypter.html" title="Adaptee (intern interface for Epcos and Nortel)." alt="Crypter" shape="rect" coords="0,56,84,80"/>
<area href="class_object.html" title="Common Baseclass for all other classes." alt="Object" shape="rect" coords="0,0,84,24"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a43b61905836c8f5779b6805587f62837"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_caesar_crypt.html#a43b61905836c8f5779b6805587f62837">Decrypt</a> ()</td></tr>
<tr class="memdesc:a43b61905836c8f5779b6805587f62837"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decrypts a string with certain crypto algorithm.  <a href="#a43b61905836c8f5779b6805587f62837"></a><br/></td></tr>
<tr class="separator:a43b61905836c8f5779b6805587f62837"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1e8fa665eb85e26bdddd1ec49f71327"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_caesar_crypt.html#ad1e8fa665eb85e26bdddd1ec49f71327">Encrypt</a> ()</td></tr>
<tr class="memdesc:ad1e8fa665eb85e26bdddd1ec49f71327"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encrypts a string with certain crypto algorithm.  <a href="#ad1e8fa665eb85e26bdddd1ec49f71327"></a><br/></td></tr>
<tr class="separator:ad1e8fa665eb85e26bdddd1ec49f71327"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a600ff4ce821214aae44d630be103ea69"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_caesar_crypt.html#a600ff4ce821214aae44d630be103ea69">getFileExtension</a> () const </td></tr>
<tr class="memdesc:a600ff4ce821214aae44d630be103ea69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get file extension This function gets the file extension from the corresponding crypto algorithm.  <a href="#a600ff4ce821214aae44d630be103ea69"></a><br/></td></tr>
<tr class="separator:a600ff4ce821214aae44d630be103ea69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_crypter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_crypter')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_crypter.html">Crypter</a></td></tr>
<tr class="memitem:a6c087f1b08c2f9c0eb756826c513c9fb inherit pub_methods_class_crypter"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_crypter.html#a6c087f1b08c2f9c0eb756826c513c9fb">getOutputFilename</a> (std::string const &amp;fileName) const </td></tr>
<tr class="memdesc:a6c087f1b08c2f9c0eb756826c513c9fb inherit pub_methods_class_crypter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates the output filename after encrypting This function gets the output filename of a file (it appends the file extension of decrypted file)  <a href="#a6c087f1b08c2f9c0eb756826c513c9fb"></a><br/></td></tr>
<tr class="separator:a6c087f1b08c2f9c0eb756826c513c9fb inherit pub_methods_class_crypter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ad991e1c2b987553326d7a7b0c30d6d inherit pub_methods_class_crypter"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_crypter.html#a2ad991e1c2b987553326d7a7b0c30d6d">getRawFilename</a> (std::string const &amp;fileName) const </td></tr>
<tr class="memdesc:a2ad991e1c2b987553326d7a7b0c30d6d inherit pub_methods_class_crypter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates the raw filename after decrypting This function gets the raw filename of a file (it cuts the file extension of encrypted file if extension is existent)  <a href="#a2ad991e1c2b987553326d7a7b0c30d6d"></a><br/></td></tr>
<tr class="separator:a2ad991e1c2b987553326d7a7b0c30d6d inherit pub_methods_class_crypter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5c8dacf8f51d2ef454d84f9caf35e26 inherit pub_methods_class_crypter"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_crypter.html#ad5c8dacf8f51d2ef454d84f9caf35e26">ReadFile</a> (std::string const &amp;fileName)</td></tr>
<tr class="memdesc:ad5c8dacf8f51d2ef454d84f9caf35e26 inherit pub_methods_class_crypter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a file.  <a href="#ad5c8dacf8f51d2ef454d84f9caf35e26"></a><br/></td></tr>
<tr class="separator:ad5c8dacf8f51d2ef454d84f9caf35e26 inherit pub_methods_class_crypter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae51d08eea452fc312441a19b8001f16a inherit pub_methods_class_crypter"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_crypter.html#ae51d08eea452fc312441a19b8001f16a">WriteFile</a> (std::string const &amp;fileName)</td></tr>
<tr class="memdesc:ae51d08eea452fc312441a19b8001f16a inherit pub_methods_class_crypter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes to a file.  <a href="#ae51d08eea452fc312441a19b8001f16a"></a><br/></td></tr>
<tr class="separator:ae51d08eea452fc312441a19b8001f16a inherit pub_methods_class_crypter"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_class_crypter"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_crypter')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_crypter.html">Crypter</a></td></tr>
<tr class="memitem:ae9a8779d243697070e6c9d82e6383a25 inherit pro_attribs_class_crypter"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_crypter.html#ae9a8779d243697070e6c9d82e6383a25">mData</a></td></tr>
<tr class="memdesc:ae9a8779d243697070e6c9d82e6383a25 inherit pro_attribs_class_crypter"><td class="mdescLeft">&#160;</td><td class="mdescRight">string where crypted data is stored ReadFile stores read data in this variable.  <a href="#ae9a8779d243697070e6c9d82e6383a25"></a><br/></td></tr>
<tr class="separator:ae9a8779d243697070e6c9d82e6383a25 inherit pro_attribs_class_crypter"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implements the Caesar-Crypt algorithm. </p>
<p>The class <a class="el" href="class_caesar_crypt.html" title="Implements the Caesar-Crypt algorithm.">CaesarCrypt</a> implements the virtual functions of its Base class. It's able to encrypt plain text to a Caesar encoded text and vice versa. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a43b61905836c8f5779b6805587f62837"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void CaesarCrypt::Decrypt </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Decrypts a string with certain crypto algorithm. </p>
<p>This function decrypts a string (stored in mData) with crypto algorithm and stores the result back to mData. </p>

<p>Implements <a class="el" href="class_crypter.html#a937cfc9e3d70b51c53d50fe6ee1ce2ad">Crypter</a>.</p>

</div>
</div>
<a class="anchor" id="ad1e8fa665eb85e26bdddd1ec49f71327"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void CaesarCrypt::Encrypt </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encrypts a string with certain crypto algorithm. </p>
<p>This function encrypts a string (stored in mData) with crypto algorithm and stores the result back to mData. </p>

<p>Implements <a class="el" href="class_crypter.html#a4beed1b9381bf390d1320f8dd423fb23">Crypter</a>.</p>

</div>
</div>
<a class="anchor" id="a600ff4ce821214aae44d630be103ea69"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::string CaesarCrypt::getFileExtension </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get file extension This function gets the file extension from the corresponding crypto algorithm. </p>
<p>The extension is provided by algorithm </p>
<dl class="section return"><dt>Returns</dt><dd>string file extension </dd></dl>

<p>Implements <a class="el" href="class_crypter.html#ab3902e58828a66bf802954ec180e6e31">Crypter</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_caesar_crypt.html">CaesarCrypt</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.2 </li>
  </ul>
</div>
</body>
</html>
